<!-- HTML header for doxygen 1.8.20-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<meta http-equiv="X-UA-Compatible" content="IE=9"/>
	<meta name="generator" content="Doxygen 1.9.4"/>
	<meta name="viewport" content="width=device-width, initial-scale=1"/>
	<title>Raspberry Pi Pico SDK: hardware_xosc</title>
	<!-- <link href="tabs.css" rel="stylesheet" type="text/css"/> -->
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="dynsections.js"></script>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
    <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
	<link href="doxygen.css" rel="stylesheet" type="text/css" />
	<link href="normalise.css" rel="stylesheet" type="text/css"/>
<link href="main.css" rel="stylesheet" type="text/css"/>
<link href="styles.css" rel="stylesheet" type="text/css"/>
</head>
<body>
	<div class="navigation-mobile">
		<div class="logo--mobile">
			<a href="/"><img src="logo-mobile.svg" alt="Raspberry Pi"></a>
		</div>
		<div class="navigation-toggle">
			<span class="line-1"></span>
			<span class="line-2">
				<p>Menu Toggle</p>
			</span>
			<span class="line-3"></span>
		</div>
	</div>
	<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
		<div class="logo">
			<a href="index.html"> <img src="logo.svg" alt="Raspberry Pi"></a>
			<span style="display: inline-block; margin-top: 10px;">
				v2.1.0
			</span>
		</div>
		<div class="navigation-footer">
			<img src="logo-mobile.svg" alt="Raspberry Pi">
			<a href="https://www.raspberrypi.com/" target="_blank">By Raspberry Pi Ltd</a>
		</div>
<!-- 		<div class="search">
			<form>
				<input type="search" name="search" id="search" placeholder="Search">
				<input type="submit" value="Search">
			</form>
		</div> -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__hardware__xosc.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">hardware_xosc<div class="ingroups"><a class="el" href="group__hardware.html">Hardware APIs</a></div></div></div>
</div><!--header-->
<div class="contents">

<p>Crystal Oscillator (XOSC) API.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga487dbffc27f23bdb4da3a0c372b800fb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__xosc.html#ga487dbffc27f23bdb4da3a0c372b800fb">xosc_init</a> (void)</td></tr>
<tr class="memdesc:ga487dbffc27f23bdb4da3a0c372b800fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the crystal oscillator system.  <a href="group__hardware__xosc.html#ga487dbffc27f23bdb4da3a0c372b800fb">More...</a><br /></td></tr>
<tr class="separator:ga487dbffc27f23bdb4da3a0c372b800fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac88fa43c5100c86992b7af29f664a30a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__xosc.html#gac88fa43c5100c86992b7af29f664a30a">xosc_disable</a> (void)</td></tr>
<tr class="memdesc:gac88fa43c5100c86992b7af29f664a30a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable the Crystal oscillator.  <a href="group__hardware__xosc.html#gac88fa43c5100c86992b7af29f664a30a">More...</a><br /></td></tr>
<tr class="separator:gac88fa43c5100c86992b7af29f664a30a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f3d06c0cf19801074cee35f0aa35f9f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hardware__xosc.html#ga7f3d06c0cf19801074cee35f0aa35f9f">xosc_dormant</a> (void)</td></tr>
<tr class="memdesc:ga7f3d06c0cf19801074cee35f0aa35f9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the crystal oscillator system to dormant.  <a href="group__hardware__xosc.html#ga7f3d06c0cf19801074cee35f0aa35f9f">More...</a><br /></td></tr>
<tr class="separator:ga7f3d06c0cf19801074cee35f0aa35f9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p >Crystal Oscillator (XOSC) API. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="gac88fa43c5100c86992b7af29f664a30a" name="gac88fa43c5100c86992b7af29f664a30a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac88fa43c5100c86992b7af29f664a30a">&#9670;&nbsp;</a></span>xosc_disable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void xosc_disable </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disable the Crystal oscillator. </p>
<p >Turns off the crystal oscillator source, and waits for it to become unstable </p>

</div>
</div>
<a id="ga7f3d06c0cf19801074cee35f0aa35f9f" name="ga7f3d06c0cf19801074cee35f0aa35f9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7f3d06c0cf19801074cee35f0aa35f9f">&#9670;&nbsp;</a></span>xosc_dormant()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void xosc_dormant </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the crystal oscillator system to dormant. </p>
<p >Turns off the crystal oscillator until it is woken by an interrupt. This will block and hence the entire system will stop, until an interrupt wakes it up. This function will continue to block until the oscillator becomes stable after its wakeup. </p>

</div>
</div>
<a id="ga487dbffc27f23bdb4da3a0c372b800fb" name="ga487dbffc27f23bdb4da3a0c372b800fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga487dbffc27f23bdb4da3a0c372b800fb">&#9670;&nbsp;</a></span>xosc_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void xosc_init </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initialise the crystal oscillator system. </p>
<p >This function will block until the crystal oscillator has stabilised. </p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->

	<script src="main.js"></script>
</body>
</html>